Introduction

You communicate about your design and code in different ways. UML models are used to communicate your design information. These include: domain model, class model, statecharts, and sequence diagrams. Code is not just for machines to understand; humans have to read your code as well. Not just for the newbie that just joined the team, but also for you or rather your future self when you have to fix a bug in your "old" code. This lesson describes the purpose of each of the UML models that you will create through this term, and teaches good coding ettiquete.

Learning Outcomes

• Describe the purpose of the UML domain model, class model, statechart, and sequence diagram.
• Use meaningful names in code (class, attribute, methods)
• Establish and adhere to a team coding style
• Document your API using javadocs
• Document your algorithms with in-line comments

Study Resources

For your study of the UML models refer to resources in the lessons Domain analysis, Review OO concepts, State-based behavior I, and Sequence diagrams. (Note: the Sequence diagrams lesson is later in the term.)

For your study of code communication, use these resources.

Video Lessons

• Documenting code with Javadoc available on LinkedIn.com through the RIT library.(5m 27s)

Web Articles and Blogs

• Robert's Rules of Coders: #3 Use Good, Meaningful Names
• Meaningful Name
• Oracle's Javadoc tool documentation
• HOW TO JAVADOC (EFFICIENT AND MAINTAINABLE) - 6 STEPS
• More Effective Javadocs
• A Seamless Way to Keep Track of Technical Debt in Your Source Code

Wikipedia

• Javadoc
• Software peer review
• Code review

Class Lecture

• Design and Code Communication

Exercises

Before-Class Exercises

• Watch the video lesson and read the Use Good, Meaningful Names blog.